home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 19.zip / BS1 part 19 / AmigaLibDisk 154.adf / DiskLib / lib.doc < prev    next >
Text File  |  1987-06-15  |  8KB  |  230 lines
  1.  
  2.             Lib, ToLib
  3.  
  4.         Disk Library Documentation System
  5.  
  6.     By Wilson Snyder        (c) January 1988
  7.  
  8.     This package contains two programs, Lib which is used to
  9.     print information on the disk, and ToLib which does simple
  10.     translation on Fred Fish's README.list## files.  (Or, on
  11.     later disk Contents files.)
  12.  
  13.     This program is PUBLIC DOMAIN, but if you wish to support
  14.     a college student working on software, your donations are
  15.     greatly appreciated.
  16.  
  17.     NOTICE:
  18.  
  19.     This program was written as a service to the amiga
  20.     users.  This program may be used by all parties, including
  21.     sale (see below) as long as the author's name and address
  22.     remains intact in the program and documentation.
  23.     Distribution of this program by parties selling it
  24.     as part of a commercial for-profit package of over $10
  25.     must contact the address below before such a package is sold.
  26.  
  27.     I make no warranties over this program, performance,
  28.     etc.  And any costs incurred by this program, or its
  29.     actions are placed on the user.
  30.  
  31.     PLEASE FORWARD INPROVEMENTS MADE TO THIS PROGRAM TO:
  32.  
  33.     Wilson Snyder, 15 Davis Parkway, South Burlington, VT 05403
  34.  
  35.                 LIB
  36.  
  37. Usage:
  38.     LIB [directoryname] [-s[ize]] [-h[eader]]
  39.     TOLIB (input_contents_file) (outputfile) ["the disk name"]
  40.     [] optional, () required.
  41.  
  42. Description:
  43.  
  44.       Lib searches the disk tree starting at the directory name
  45.     provided, or the root of the current disk if no directory
  46.     is provided.  The program prints out each directory in
  47.     sorted order, with the size if the -s option is used, and
  48.     with page headers if the -h option is used.
  49.     If a file named $$DES$$ is found in any one of the directories
  50.     the contents of the file are printed out using simple
  51.     word justification and page numbering (-h option).
  52.  
  53.       ToLib converts a contents or readme.list file to a single
  54.     file containing several $$DES$$ files-in-one for each
  55.     entry in the contents file.  The computer assumes that the
  56.     program name starts in the first column, and that the
  57.     description of the file is indented by a tab or space from the
  58.     first column.  When the program encounters a new program name
  59.     it prints the optional diskname.  After the program is finished
  60.     I load the file into my editor, and chop the file into $$DES$$
  61.     files under each subdirectory, and a $$DES$$ file for the root.
  62.  
  63. Why:
  64.  
  65.       Fred Fish provides a excellent service to the Amiga
  66.     community, but he must distribute information as he gets it,
  67.     and has to pack many different types of programs on each
  68.     disk.  When I receive his disks I prefer to seperate the
  69.     programs by topic, onto one disk per topic.  Fred provides
  70.     a contents file on his disks, but since I want the description
  71.     information on my topic disks, I would have to use a editor
  72.     to delete the description from the distribution disk and place
  73.     it onto a contents file on each topic disk.
  74.       This program offers another solution.  When I recieve a new
  75.     Fred Fish (or other PD?!) disk, I run the TOLIB program which
  76.     changes the contents file into a form ready to be split into
  77.     sub files.  I then put the description for each file into that
  78.     file's directory so that copying the directory [ALL] will also
  79.     copy the description for that program.
  80.       Now, when I want a list of the contents of my disks I can
  81.     just run the LIB program on each disk, and it will produce a
  82.     file simular to the Contents file, but much more accurate as
  83.     it will display files even without descriptions, and will not
  84.     display descriptions for files that do not exist on the disk.
  85.     (Thus deleting/moving the directory of the program automatically
  86.     deletes/moves the description.)
  87.  
  88. The Future:
  89.  
  90.       To make life easy for those who split up the programs on
  91.     the Fred Fish disks, I Propose that Fred distribute his disks
  92.     with the $$DES$$ files.  Thus, people who donate to the library
  93.     can just give Fred a $$DES$$ file, which he may edit.  Once
  94.     he has copied all of the programs he wishes onto a distribution
  95.     disk, he need only run the LIB program to produce a master
  96.     contents file for the benefit of users without the LIB program,
  97.     and also for quick viewing of the contents.  Information on the
  98.     disk itself, for example the words "Disk ### of the freely..."
  99.     can simply be placed on the root $$DES$$ file.
  100.  
  101.  
  102. Example:
  103.  
  104.     This is a dump of one of my games disks:
  105.     (Envoked with "LIB >output df1: -h -s")
  106.     Information in ALL CAPS added for information.
  107.  
  108.  
  109. Page 1                                                         Games 2
  110. ^- PAGE NUMBER                        DISK NAME --^
  111.  
  112. Games 2
  113. ^- ROOT NAME
  114.  
  115.     Disk 1 of Public Domain Games.
  116.     ^- $$DES$$ file of root
  117.  
  118.         Canfield
  119.                 Total size 27912 bytes.
  120.     ^- $$DES$$ not found, just printed the size.
  121.  
  122.         Conquest
  123.         V---  $$DES$$ file,  words "Fred Fish 24" added by TOLIB.
  124.                 Fred Fish 24 
  125.                 You control an interstellar empire, decide which star 
  126.                 systems to explore, which planets to colonize, etc.  
  127.                 The computer will also be building its own empire and 
  128.                 competing with you for resources.  The one with the 
  129.                 greatest population at the end wins.  First distributed 
  130.                 in executable form only on disk number AM010.  This 
  131.                 distribution includes source. 
  132.                 Author:  ported to Amiga by Rob Shimbo 
  133.                 
  134.                 Total size 331234 bytes.
  135.  
  136.         Cosmo
  137.                 Fred Fish 40 
  138.                 An "asteriods" clone.  Suggested $6 donation. 
  139.                 Author:  John Harris 
  140.                 
  141.                 Total size 20604 bytes.
  142.  
  143.         DietAid
  144.                 Fred Fish 36 
  145.                 Diet planning aid to allow the user to compile lists of 
  146.                 ingredients (recipes) and automatically compute calorie 
  147.                 totals, etc.  This is a shareware program ($10 
  148.                 suggested) that was submitted by the author for 
  149.                 inclusion in the library. 
  150.                 Author: Terry Gintz 
  151.                 
  152.                 Total size 102856 bytes.
  153.  
  154.         Klondike
  155.                 Total size 25077 bytes.
  156.         Puzzle
  157.                 Fred Fish 32 
  158.                 Simulation of puzzle with moving square tiles.  
  159.                 Executable only. 
  160.                 Author: Bill Beogelein 
  161.                 
  162.                 Total size 9121 bytes.
  163.  
  164.         Reversi
  165.                 Fred Fish 38 
  166.                 Program to play reversi game.  Version 6.1. 
  167.                 Author:  Manuel Almudevar 
  168.                 
  169.                 Total size 47180 bytes.
  170.  
  171. Page 2                                                         Games 2
  172. ^----- PAGE BREAK
  173.  
  174.         Rocket
  175.                 Fred Fish 82 
  176.                 Another interesting Workbench display hack.  This one 
  177.                 is really a game in disguise.  Binary only. 
  178.                 Author:  Peter da Silva 
  179.                 
  180.                 Total size 8027 bytes.
  181.  
  182.         Sword
  183.                 Fred Fish 32 
  184.                 Sword of Fallen Angel.  Text adventure game written in 
  185.                 AmigaBasic. 
  186.                 Author: Andry Rachmat 
  187.                 
  188.                 Total size 141277 bytes.
  189.  
  190.         TunnelVision
  191.                 Fred Fish 36 
  192.                 Another fine ABasiC game from David Addison.  This is  
  193.                 a maze game with a 3-D perspective view from inside the 
  194.                 maze. 
  195.                 Author: David Addison 
  196.                 
  197.         V--- DIRECTORIES UNDER TUNNELVISION
  198.                 devs
  199.                         Total size 232 bytes.
  200.                 s
  201.                         Total size 134 bytes.
  202.         V--- TUNNELVISION SIZE
  203.                 Total size 53246 bytes.
  204.  
  205.     V--- TOTAL ROOT SIZE
  206.         Total size 766534 bytes.
  207.  
  208. Limitations / Suggestions:
  209.  
  210.     1.    Each program must be in its own subdirectory, this is
  211.         standard for the Fred Fish series, and the way I wish
  212.         to keep my disks.
  213.  
  214.     2.    The text output formatter is simple, no frills.
  215.  
  216.     3.    The TOLIB program just does simple processing, spliting
  217.         up the output must be done by hand.  This could be
  218.         automated at some point.
  219.  
  220.     4.    Command line options do not exist for page length,
  221.         margins, etc.
  222.  
  223.     5.    A option could be added to LIB to show all of the files
  224.         on the disk.
  225.  
  226.     6.    A header could be added providing information on the
  227.         disk, percent full, time, date, etc.
  228.  
  229.     7.    No control-C trap exists.
  230.